Find-IMAsset

SYNOPSIS

Searches assets using metadata filters.

SYNTAX

Find-IMAsset [[-Session] <ImmichSession>] [[-Checksum] <String>] [[-City] <String>] [[-Country] <String>]
 [[-CreatedAfter] <DateTime>] [[-CreatedBefore] <DateTime>] [[-DeviceAssetId] <String>] [[-DeviceId] <String>]
 [[-EncodedVideoPath] <String>] [[-Id] <String>] [[-isEncoded] <Boolean>] [[-isFavorite] <Boolean>]
 [[-isMotion] <Boolean>] [[-isNotInAlbum] <Boolean>] [[-isOffline] <Boolean>] [[-Visibility] <String>]
 [[-LensModel] <String>] [[-LibraryId] <String>] [[-Make] <String>] [[-Model] <String>] [[-Order] <String>]
 [[-OriginalFileName] <String>] [[-OriginalPath] <String>] [[-PersonIds] <String[]>] [[-Size] <Int32>]
 [[-State] <String>] [[-TakenAfter] <DateTime>] [[-TakenBefore] <DateTime>] [[-TrashedAfter] <DateTime>]
 [[-TrashedBefore] <DateTime>] [[-Type] <String>] [[-UpdatedAfter] <DateTime>] [[-UpdatedBefore] <DateTime>]
 [[-WithDeleted] <Boolean>] [[-WithExif] <Boolean>] [[-WithPeople] <Boolean>] [[-WithStacked] <Boolean>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Finds assets by metadata properties like dates, locations, device info, and technical details. For content-based search, use Search-IMAsset instead.

EXAMPLES

EXAMPLE 1

Find-IMAsset -createdAfter (Get-Date).AddDays(-30)

Retreives all assets created in the last 30 days

EXAMPLE 2

Find-IMAsset -City 'Paris' -CreatedAfter '2024-01-01'

Finds assets taken in Paris after January 1, 2024.

PARAMETERS

-Session

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Checksum

Filter by file checksum for duplicate detection.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-City

Filter by city name from GPS data.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Country

Filter by country from GPS data.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedAfter

Include assets created after this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedBefore

Include assets created before this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceAssetId

Filter by device-specific asset identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceId

Filter by camera/device identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EncodedVideoPath

Filter by encoded video file path.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Id filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-isEncoded

Encoded filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-isFavorite

Favorite filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-isMotion

Motion filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-isNotInAlbum

Not in Album filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-isOffline

Offline filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Visibility

Asset visibility filter (archive, timeline, hidden, locked)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LensModel

Lens model filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LibraryId

Library id filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Make

Make filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Model

Model filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Order

Defines sort order

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OriginalFileName

Original file name filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OriginalPath

Original path filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PersonIds

Person id filter

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Size

Size of rest call page

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-State

State filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TakenAfter

Taken after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TakenBefore

Taken before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrashedAfter

Trashed after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrashedBefore

Trashed before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

Type filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdatedAfter

Updated after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdatedBefore

Updated before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WithDeleted

Deleted filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WithExif

Exif filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WithPeople

With people filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WithStacked

Stacked filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Use metadata-based filtering for precise technical searches.

RELATED LINKS

EDIT THIS DOC

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github